docs: document the one-line install (go install + SDK from source) - #53
Merged
Conversation
The CLI now has a copy-paste one-liner that needs no clone: `go install github.com/prashar32/riskkernel/cmd/riskkernel@latest`. The README showed only `go build`, which assumes a checkout. Also corrects the SDK README, which still read `pip install riskkernel` — the package isn't on PyPI yet, so install-from-source is the right one-liner, matching the main README.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Make installing RiskKernel a genuine one-liner on both surfaces.
go install github.com/prashar32/riskkernel/cmd/riskkernel@latest— to the README quickstart. It previously showed onlygo build -o … ./cmd/riskkernel, which assumes you've cloned the repo.pip install riskkernel, but the package isn't on PyPI yet — copy-pasting it fails. Point it at the install-from-source command, matching the main README. (PyPI publish stays on the roadmap.)Why
Adoption friction is the thing that kills a self-hosted runtime. The README is the conversion asset; the install commands in it have to actually work when pasted. The
go buildform needs a checkout, and the stalepip install riskkernelline errors out — both are friction for a first-time user.Notes
Docs only — no code or behavior change.
go install …@latestverified to produce a workingriskkernelbinary in GOBIN; the from-source pip command is the same one the main README andexamples/codebase-qaalready use.